SetSuiteLabel

SetSuiteLabel
Header:	Icons.h		Carbon status:	Supported

Specifies the default label associated with an icon suite.

OSErr SetSuiteLabel (
    IconSuiteRef theSuite, 
    SInt16 theLabel
);

theSuite

A handle to an icon suite.

theLabel

An integer from 1 to 7 that specifies a label for the icon suite, or 0 to set the icon suite’s label to none. The default label setting helps to determine which of the label colors shown in the Finder’s Label menu is applied to icons of that suite when your application displays them.

You can override the default label setting for a suite by specifying a label in the transform parameter of the PlotIconSuite function. For example, suppose the color currently set for the third label displayed in the Finder’s Label menu is red, and the color for the fourth label is green. If you set the default label for a suite using SetSuiteLabel(theSuite,3), then draw an icon from the same suite using PlotIconSuite and specifying ttNone in the transform parameter, the label color red is applied to the icon. However, if you specify ttLabel4 in the transform parameter of the PlotIconSuite function, the label color green is applied to the icon.

function result: A result code.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.